/*
 * $Id: IGuidanceLoader.java,v 1.3 2009/07/10 20:01:40 navdeep_mahajan Exp $
 * 
 * Copyright (C) 2008 General Electric Company. All Rights Reserved.
 * 
 * This software is the confidential and proprietary information of the General
 * Electric Company (GE). You shall not disclose this software and shall use it
 * only in accordance with the terms of the license agreement you entered into
 * with GE.
 * 
 * GE MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
 * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 * NON-INFRINGEMENT. GE SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE
 * AS A RESULT OF USING, MODIFYING, OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES.
 */
package com.ge.healthcare.autosc.processor.shemjob.guidance.loader;

import java.util.HashMap;

import org.w3c.dom.Node;

import com.ge.healthcare.autosc.processor.exception.GuidanceLoaderException;
import com.ge.healthcare.autosc.processor.shemjob.guidance.builder.IGuidanceElementBuilder;

public interface IGuidanceLoader {

	public void load() throws GuidanceLoaderException;
	
	/**
	 * Build configuration map using incoming label and base node. Children
	 * of the base node will be evaluated against defined/default label to determine 
	 * the key/value pair to the map
	 * @param baseNode	Element node to look for incoming labels.
	 * @param baseDescription	For error condition.
	 * @param definedLabel	Tag name to identify interested data
	 * @param keyLabel	Child identifier under element with name definedLabel/defaultLabel
	 * @param defaultLabel	Default tag name to identify interested data
	 * @param configLabel
	 * @param builder	Element builder that is used to build the map value
	 * @return
	 * @throws GuidanceLoaderException
	 */
	public HashMap<String, Object> buildConfigHash(Node baseNode,
			   					   String baseDescription,
			   					   String definedLabel,
			   					   String keyLabel,
			   					   String defaultLabel,
			   					   String configLabel,
			   					   IGuidanceElementBuilder builder )
								throws GuidanceLoaderException;
}
